Populate more metadata in compiler and runtime Python packages. #19118
Conversation
ScottTodd
added
documentation
| description="IREE Compiler API", | ||
| description="IREE Python Compiler API", | ||
| long_description=README, | ||
| long_description_content_type="text/markdown", | ||
| long_description="", | ||
| license="Apache-2.0", | ||
| classifiers=[ |
There was a problem hiding this comment.
@stellaraccident how do you feel about us changing the Development Status :: 3 - Alpha to 4 - Beta or 5 - Production/Stable?
Looks like iree-turbine is already 5 - Production/Stable 🤔
https://github.com/iree-org/iree-turbine/blob/3c6240a228543a80b109d61a0c0f521d40782164/setup.py#L90-L91
Others:
- https://pypi.org/project/sharktank/ 3 - alpha
- https://pypi.org/project/shortfin/ unspecified
| project_urls={ | ||
| "homepage": "https://iree.dev/", | ||
| "repository": "https://github.com/iree-org/iree", | ||
| "documentation": "https://iree.dev/reference/bindings/python/", |
There was a problem hiding this comment.
I considered linking to https://iree-python-api.readthedocs.io/en/latest/ here, but we don't have a link from readthedocs back to iree.dev.
There was a problem hiding this comment.
Yes, let's go with iree.dev for now which at least links to rtd.
| ), | ||
| "rt", | ||
| ) as f: | ||
| README = f.read() |
There was a problem hiding this comment.
A more lightweight solution could be to add readme = "README.md" to the pyproject.toml but as it only defines the build dependencies for this Python package, I would stick with what you got here.
There was a problem hiding this comment.
That could work. Note that we have README files in two locations for the runtime package, and I'm matching that structure here for the compiler package:
- https://github.com/iree-org/iree/blob/main/runtime/README.md (sibling to
setup.pyandpyproject.toml) - https://github.com/iree-org/iree/blob/main/runtime/bindings/python/iree/runtime/README.md (content for PyPI)
- https://github.com/iree-org/iree/blob/main/compiler/README.md (sibling to
setup.pyandpyproject.toml)
Should probably make a pass through and clean up the files. Some were last updated halfway through code restructuring:
Lines 1 to 8 in 4477091
There was a problem hiding this comment.
Feels like we might want to move https://github.com/iree-org/iree/blob/main/runtime/bindings/python/iree/runtime/README.md closer to https://github.com/iree-org/iree/tree/main/docs/api_docs/python (not merging it with the README.md there but moving into a newly to create _static folder).
There was a problem hiding this comment.
Interesting idea. I feel like API docs and a package README are a bit different though 🤔
There was a problem hiding this comment.
I have confused myself and therefore it is not an interesting idea at all and rather wrong. I thought the README I was referring to was used for RTD but that is obviously not the case you mentioned it is used for PyPi. We should than probably fuse the two READMEs we have for the runtime?
| project_urls={ | ||
| "homepage": "https://iree.dev/", | ||
| "repository": "https://github.com/iree-org/iree", | ||
| "documentation": "https://iree.dev/reference/bindings/python/", |
There was a problem hiding this comment.
Yes, let's go with iree.dev for now which at least links to rtd.
…-org#19118) This will add more content to https://pypi.org/project/iree-base-compiler/ and https://pypi.org/project/iree-base-runtime/. We can also add more text to the README files or use the repository root README instead. Docs I followed: * https://packaging.python.org/en/latest/specifications/core-metadata/ * https://packaging.python.org/en/latest/specifications/well-known-project-urls/#well-known-project-urls
…-org#19118) This will add more content to https://pypi.org/project/iree-base-compiler/ and https://pypi.org/project/iree-base-runtime/. We can also add more text to the README files or use the repository root README instead. Docs I followed: * https://packaging.python.org/en/latest/specifications/core-metadata/ * https://packaging.python.org/en/latest/specifications/well-known-project-urls/#well-known-project-urls Signed-off-by: Giacomo Serafini <[email protected]>
This will add more content to https://pypi.org/project/iree-base-compiler/ and https://pypi.org/project/iree-base-runtime/. We can also add more text to the README files or use the repository root README instead.
Docs I followed: